CygNet Measurement > CygNet Measurement Overview > Installation

Installing CygNet Measurement

You can install CygNet Measurement on an existing or new CygNet Software installation, or as an upgrade from an earlier version of CygNet Measurement.

To Install CygNet Measurement on an Existing CygNet Software Installation

Follow the procedures and meet the requirements listed and referenced in this document.

To Install CygNet Measurement with a New CygNet Software Installation

Acquire the proper licenses and install the required version of CygNet Measurement along with all other essential and required CygNet Software components.

See the CygNet Quick Start document or contact CygNet Support to access resources to assist with initial CygNet Software installation.

To Install CygNet Measurement to Upgrade an Existing Version of the Application:

Consider additional information in order to upgrade form an earlier to a later version of CygNet Measurement, including details about updating your FMS service database schema in the event of a database change, and updating associated FMS application, template, command, and related files as necessary.

See the CygNet Upgrade Procedure for more information.

The following definitions clarify references to the names CygNet Measurement, FMS, and FMS Explorer.

Installing CygNet Measurement on an Existing CygNet Software Installation

Review the following subsections for more information before beginning to install CygNet Measurement.

  1. Preliminary Requirements
  2. Installing Microsoft SQL Server and Databases
  3. Installing the FMS Service
  4. Installing and Registering Support Files
  5. Installing and Registering Optional Database Client and Support Files
  6. Uploading Files to the APPS Service
  7. Installing the FMS Explorer Client
  8. Installing the FMS Toolbox Utility
  9. Installing the Optional FMS Internal Database Manager Utility

See Troubleshooting CygNet Measurement for information about start-up errors that might be encountered during installation.

1. Preliminary Requirements

Before you begin installing CygNet Measurement on an existing CygNet Software installation, meet the following requirements.

Server and Client Requirements

Obtain the following information for your system. See the CygNet System Requirements document for more information.

CygNet Software Requirements

*Note: This file is not supported for use outside the run-time environment of the FMS Service.

Once you have met the above requirements and are ready to proceed, go to 2. Installing Microsoft SQL Server and Databases.

Back to top

2. Installing Microsoft SQL Server, Native Client, and Databases

Before installing CygNet Measurement, you must install the Microsoft SQL Server and create a database for your FMS service (unless your installation will use the FMS internal database. See Using the FMS Internal Database for more information about database selection).

Note: Although CygNet Measurement maintains a full audit trail for device data, there is no inherent audit trail in SQL. This means that editing data directly in SQL provides no audit trail of those edits, therefore it is important that only SQL administrators should have access to the SQL database.

To Install Microsoft SQL Server and Databases

  1. Properly install Microsoft SQL Server, if you are not already using it. Refer to Microsoft SQL Server online documentation for more information and instructions.
  2. If you plan to run the Microsoft SQL Server and the FMS service on different physical computers, install Microsoft SQL Server Native Client (sqlncli.msi, 32-bit or 64-bit version) on the computer hosting your FMS service (your service computer). Install with Administrator rights. Refer to Microsoft SQL Server Native Client online documentation for more information and instructions.
  3. Create a new database to serve only as your FMS SQL Server database. The FMS Service requires a one-to-one relationship with the FMS SQL Server database, therefore the account running the FMS Service needs read/write access to the designated FMS SQL Server database and its tables plus the ability to create or modify tables.

    Ensure that the FMS SQL Server database remains pristine by instituting security measures that allow database permissions only to the FMS Service and authorized SQL database administrators. Contact your system administrator or refer to Microsoft online documentation at https://msdn.microsoft.com/ for more information about current permission settings for Microsoft SQL Server.

    Note: FMS needs no additional SQL Server database permissions beyond those required to fully access the single SQL Server database created for FMS.

  1. Open Microsoft SQL Server Management Studio (SMSS).
  1. Locate the server that will contain your new FMS database and click Connect.
  2. Expand Databases in the Object Explorer, right-click Databases, click New Database, and enter a Database name. Make any other settings changes required and then click OK. See Note below.
  3. In the Object Explorer, select your new FMS database and then click File > Open > File.
  1. In your CygNet Measurement source files, browse to the CreateFmsDatabase.sql file in the CygNet\Services\FMS folder and click Open.
  1. At the top of the CreateFmsDatabase.sql file, in the [YourDatabaseNameHere] placeholder, type the name of your new CygNet Measurement (FMS) database and click Execute.
  2. When your query executes successfully, Save and exit Microsoft SQL Server Management Studio.

Note: If you find it necessary to disable the capability to create or modify database tables for the SQL Server database manager tool, the disabled capability must be temporarily restored any time a database update is done so that table schemes can be modified and the system can be kept current. Such capabilities can again be disabled if necessary once each database update is complete.

Once Microsoft SQL Server has been set up and an FMS database has been created, go to 3. Installing the FMS Service.

Back to top

3. Installing the FMS Service

Follow this procedure to install and activate FMS so that it is displayed in CygNet Explorer and interacts with other core CygNet SCADA services and the SQL database.

To Install the FMS Service

  1. Open CygNet Host Manager, and locate the Remote Service Manager (RSM) for the site to which you are adding FMS. The FMS service and RSM service must be on the same computer.
  1. Select the RSM service from the list on the Service Status tab and then click Stop to stop the service.
  2. Once the service has stopped, click File and then Exit CygNet Host Manager to exit CygNet Host Manager.
  1. Using Windows Explorer, locate the CygNet\Services\ARS folder on your host server.
  1. Copy your new CygNet.lic file into the folder. It must overwrite any existing CygNet.lic file.
  2. Copy a properly defined CygNetTimeZones.xml file into the folder.
  1. Copy the FMS folder from your source to the CygNet\Services folder on your host server. This folder must include at least the following files.
  1. In the CygNet\Services\FMS folder on your host server, open the fms.cfg file in a text editor.
  1. Replace XXX with your site name for all relevant services.
  2. Update the DB_SERVER keyword with the name of the computer hosting your SQL database.
  3. Update the DB_CATALOG keyword with the name of the database you've created for this FMS service.
  4. Depending on your method of authentication, you might need to set the DB_USERNAME and DB_PASSWORD keywords.
  5. Save the configuration file and exit.
  1. In order to send reports via email, you must add SMTP keyword values to the FMS configuration file. See Email Info Keywords and Configuring Email Options for more information.
  2. In the CygNet\Services folder on your host server, open the UIS folder.
  1. Open the Uis.cfg file in a text editor.
  2. In the Associated Services section of the Uis.cfg file, delete the pound sign (#) from in front of FMS.
  3. For multiple FMS services, add the additional Site.Service name(s) to the FMS line, separated by spaces.
  4. Save the configuration file and exit.
  1. Open CygNet Host Manager and start the Remote Service Manager (RSM) for the site to which you are adding FMS.
  2. Using CygNet Explorer, open the Access Control Service (ACS) to configure security for the FMS service.
  1. Add a new FMS application. See To Add an Application for more information.
  2. Add security events and permissions to the new application. See To Add an Event to an Application and FMS Security for more information. Security events are as follows.
  1. In order to publish normalized data to the CygNet SCADA system, you must add the FMS service to the ADMINS group in the ACS, to provide appropriate security for the FMS service to make updates to the UIS and the VHS services. The following steps describe how to build this security configuration.
  1. In the ACS, click the Groups tab or right-click in the white space of the service window and click View Groups.
  2. Right-click in the white space of the service pane and click New Group.
  3. In the Group text box, type an ID for the FMS service group, e.g. SVC_FMS.
  4. In the Description text box, type a description for the group, e.g. FMS Group.
  5. Add a Group Member.
  1. In the Group Members area, click New.
  2. Select US - User as the Security ID Type.
  3. Type "FMS" as the User.
  4. Click OK twice.
  1. Add the FMS service group to the SERVICES group.
  1. Double-click one of the SERVICES listings. Click View Group.
  2. In the Group Members area, click New.
  3. Select CG - CygNet Group as the Security ID Type.
  4. Type the Group, e.g. SVC_FMS.
  5. Click OK twice.
  1. Verify that the SERVICES group is a member of the ADMINS group.
  1. Double-click the ADMINS SERVICES group.
  2. Click View Group.
  3. Confirm that SERVICES is a member.
  4. If not, add it as described in step f.
  5. Click OK.
  1. In CygNet Explorer, open your Address Resolution Service (ARS).
  1. Right-click in the white space of the service pane and click New.
  2. Select FMS from the Service Type drop-down menu, enter a Site and a Description, and then click OK.
  1. In CygNet Explorer, open your Remote Service Manager (RSM).
  1. Right-click in the white space of the RSM service pane and click New.
  2. Select the newly added FMS service from the Service Name list. Do not start the newly added FMS service yet. The RSM and FMS must be in the same CygNet\Services folder. In the Directories section of the dialog box, verify or enter the correct Executable path and Data path for FMS.
  3. Click OK.

Note: Check the permissions in the user account associated with your FMS service. For FMS SVCMON and Replication status checks to succeed, proper table permissions must be set. Refer to Microsoft online documentation at https://msdn.microsoft.com/ for more information about IDENTITY_INSERT and table permission settings for Microsoft SQL Server.

Once the FMS service has been installed on your existing CygNet system, go to 4. Installing and Registering Support Files.

Back to top

4. Installing and Registering Support Files for the FMS Service

Follow this procedure to install and register CygNet Measurement support files for your FMS Service.

To Install and Register Support Files for the FMS Service

  1. Using Windows Explorer, locate the following support files in your source and copy them to the Support folder on your host server.
  2. For each of the copied files, right-click the file, and then click Open. You might first have to choose a program with which to open and register the files. If so, browse to the Windows\System32 directory and double-click regsvr32.exe on a 32-bit operating system (use Windows\SysWOW64\regsvr32.exe on a 64-bit operating system).
  3. In CygNet Explorer, open your RSM, right-click on the newly installed FMS service, and click Start.
  4. In your source files, locate the StudSupp.rsq file in the CygNet\Support folder and do the following.
    1. Download the file from the APPS BLOB, and make the following modifications.
      1. In the linked .rsp files section, add the line [SUPPORT]..\SUPPORT\FmsSupp.rsp.
      2. Add the line [SUPPORT]..\SUPPORT\FmsSupp2.rsp.
      3. Save and close the file.
    2. Upload the edited file to the APPS BLOB. See Blob Storage Service for more information.

If you experience start-up errors, see Common Start-up Errors for troubleshooting help.

Once your FMS service is installed and running within the CygNet system, if you will be installing optional functionality go to 5. Installing and Registering Optional Support Files , otherwise go to 6. Uploading Files to the APPS Service.

5. Installing and Registering Optional Database Client and Support Files

Certain FMS functionality is provided as an optional licensed feature set. If your system license includes this feature set, both an Oracle database client and manual installation and registration of corresponding CygNet Measurement support files are required to access the feature set. Use the following procedures to use this optional functionality.

Before installing the optional files, you must have access to an Oracle database connection that is compatible with your system, and that is located on the same host computer as your FMS Service. The following steps explain how to provide the required database client for your host computer.

To Install the Oracle Database Client

Note: Refer to Oracle Database Client/Flow-Cal documentation and/or contact your Oracle/Flow-Cal representatives for the most current information about specific installation details.

  1. Verify or perform installation of a compatible Oracle Database Client (32-bit version) on the computer hosting your FMS service (your client computer). For installation type, select the Administrator option.
  2. Restart your client computer.
  3. Verify the database connection.
  4. In the CygNet\Services\FMS folder on your host server, open the FMS configuration file (fms.cfg) and configure the Database Info service configuration keywords for your Flow-Cal database connection. See FMS Configuration File Keywords for more information.

Once the Oracle database client installation is complete, install and register the optional support files. The following steps explain how to manually install and register the corresponding CygNet Measurement support files for your FMS Service.

To Install and Register Optional Support Files: Flow-Cal Data Export Commands

  1. On your host server, do the following.
  1. Copy the driver file (CxFmsFlowCalExport.dll) from the CygNet\Support folder in the CygNet Software source files to the CygNet\Support folder on your host server.
  2. Open and register the copied file as follows. Browse to the Windows\System32 directory and double-click to open regsvr32.exe (on a 64-bit operating system, use Windows\SysWOW64\regsvr32.exe) to register the file. A confirmation message will appear when registration is complete.
  3. Copy the sample command definition file(s), SampleExportFlowCal.cdf, and/or SampleExportFlowCalDB.cdf, and/ or SampleExportFlowCalTicket.cdf, from the CygNet\Services\Fms folder in the CygNet Software source files to the CygNet\Services\Fms\CommandDefs folder on your host server.
  4. Remove the word "Sample" from the file name(s) you have placed in the CommandDefs folder, so the name reads "ExportFlowCal.cdf" and/or "ExportFlowCalDB.cdf" and/or "ExportFlowCalTicket.cdf" and the file(s) will be recognized by the FMS service.
  5. Optionally edit or customize the command definition file(s). See the corresponding "Export: Flow-Cal ... Commands" configuration topics in the Managing Node Commands section for more information about editing and customizing the command definition files for each export command used.
  1. In CygNet Explorer, do the following.
  1. Open the RSM (Remote Service Manager) and right-click on your FMS (Flow Measurement Service) Site.Service to access the context menu.
  2. Click Restart to restart your FMS Service.
  3. The selected export commands will now be displayed in FMS command selection dialogs in your application. See FMS Commands for more information.
Back to top

6. Uploading Files to the APPS Service

Upload the following files to your APPS service (the BLOB storage service that stores your CygNet client application files), so that applications installed using the CygNet Client Installer (e.g. steps 7 and 8) can be provided with integrated version management. See Version Management for more information.

To Upload Files to the APPS Service

Once the required files are present in your APPS service, you can install the FMS Explorer client and the FMS Toolbox utility, using the CygNet Client Installer to set up integrated version management (and optionally the FMS Internal Database Manager utility, if using that option). Go to 7. Installing the FMS Explorer Client and 8. Installing the FMS Toolbox Utility.

7. Installing the FMS Explorer Client

FMS Explorer is the primary user interface for the CygNet Measurement application. It provides both administrative and user functionality. Once the required files are present in the APPS service, FMS Explorer can be installed using the CygNet Client Installer.

To Install the FMS Explorer Client

8. Installing the FMS Toolbox Utility

FMS Toolbox is a CygNet provided set of tools for importing data into the CygNet Measurement application, from within or outside the FMS system. Once the required files are present in the APPS service, FMS Toolbox can be installed using the CygNet Client Installer.

To Install the FMS Toolbox Utility

9. (Optional) Installing the FMS Internal Database Manager Utility

FMS Internal Database Manager is a CygNet provided utility for managing the CygNet Measurement database, when using the FMS Internal Database option. Use the utility to retrieve records from the internal database using SQL queries, and to copy and save results as CSV files.

To Install the FMS Internal Database Manager Utility

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.